<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>PreciseDurationDateTimeField xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/goda/time/field/PreciseDurationDateTimeField.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2005 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time.field;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DateTimeFieldType;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DurationField;
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment">/**</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * Precise datetime field, which has a precise unit duration field.</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * PreciseDurationDateTimeField is thread-safe and immutable, and its</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * subclasses must be as well.</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> *</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * @author Brian S O'Neill</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> */</em>
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/goda/time/field/PreciseDurationDateTimeField.html">PreciseDurationDateTimeField</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/goda/time/field/BaseDateTimeField.html">BaseDateTimeField</a> {
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 5004523158306266035L;
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The fractional unit in millis */</em>
<a name="35" href="#35">35</a>      <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> iUnitMillis;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/goda/time/DurationField.html">DurationField</a> iUnitField;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>      <em class="jxr_javadoccomment">/**</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">     * Constructor.</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">     * </em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment">     * @param type  the field type</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     * @param unit  precise unit duration, like "days()".</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if duration field is imprecise</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if unit milliseconds is less than one</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     */</em>
<a name="47" href="#47">47</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/field/PreciseDurationDateTimeField.html">PreciseDurationDateTimeField</a>(<a href="../../../../org/goda/time/DateTimeFieldType.html">DateTimeFieldType</a> type, <a href="../../../../org/goda/time/DurationField.html">DurationField</a> unit) {
<a name="48" href="#48">48</a>          <strong class="jxr_keyword">super</strong>(type);
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>          <strong class="jxr_keyword">if</strong> (!unit.isPrecise()) {
<a name="51" href="#51">51</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Unit duration field must be precise"</span>);
<a name="52" href="#52">52</a>          }
<a name="53" href="#53">53</a>  
<a name="54" href="#54">54</a>          iUnitMillis = unit.getUnitMillis();
<a name="55" href="#55">55</a>          <strong class="jxr_keyword">if</strong> (iUnitMillis &lt; 1) {
<a name="56" href="#56">56</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"The unit milliseconds must be at least 1"</span>);
<a name="57" href="#57">57</a>          }
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>          iUnitField = unit;
<a name="60" href="#60">60</a>      }
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>      <em class="jxr_javadoccomment">/**</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * Returns false by default.</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     */</em>
<a name="65" href="#65">65</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isLenient() {
<a name="66" href="#66">66</a>          <strong class="jxr_keyword">return</strong> false;
<a name="67" href="#67">67</a>      }
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <em class="jxr_javadoccomment">/**</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     * Set the specified amount of units to the specified time instant.</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     * </em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to set in</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * @param value  value of units to set.</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * @return the updated time instant.</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if value is too large or too small.</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     */</em>
<a name="77" href="#77">77</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> set(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">int</strong> value) {
<a name="78" href="#78">78</a>          FieldUtils.verifyValueBounds(<strong class="jxr_keyword">this</strong>, value, getMinimumValue(),
<a name="79" href="#79">79</a>                                       getMaximumValueForSet(instant, value));
<a name="80" href="#80">80</a>          <strong class="jxr_keyword">return</strong> instant + (value - get(instant)) * iUnitMillis;
<a name="81" href="#81">81</a>      }
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em class="jxr_javadoccomment">/**</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * This method assumes that this field is properly rounded on</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * 1970-01-01T00:00:00. If the rounding alignment differs, override this</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * method as follows:</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     * return super.roundFloor(instant + ALIGNMENT_MILLIS) - ALIGNMENT_MILLIS;</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     */</em>
<a name="91" href="#91">91</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> roundFloor(<strong class="jxr_keyword">long</strong> instant) {
<a name="92" href="#92">92</a>          <strong class="jxr_keyword">if</strong> (instant &gt;= 0) {
<a name="93" href="#93">93</a>              <strong class="jxr_keyword">return</strong> instant - instant % iUnitMillis;
<a name="94" href="#94">94</a>          } <strong class="jxr_keyword">else</strong> {
<a name="95" href="#95">95</a>              instant += 1;
<a name="96" href="#96">96</a>              <strong class="jxr_keyword">return</strong> instant - instant % iUnitMillis - iUnitMillis;
<a name="97" href="#97">97</a>          }
<a name="98" href="#98">98</a>      }
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <em class="jxr_javadoccomment">/**</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * This method assumes that this field is properly rounded on</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * 1970-01-01T00:00:00. If the rounding alignment differs, override this</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * method as follows:</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">     * return super.roundCeiling(instant + ALIGNMENT_MILLIS) - ALIGNMENT_MILLIS;</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">     */</em>
<a name="108" href="#108">108</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> roundCeiling(<strong class="jxr_keyword">long</strong> instant) {
<a name="109" href="#109">109</a>         <strong class="jxr_keyword">if</strong> (instant &gt; 0) {
<a name="110" href="#110">110</a>             instant -= 1;
<a name="111" href="#111">111</a>             <strong class="jxr_keyword">return</strong> instant - instant % iUnitMillis + iUnitMillis;
<a name="112" href="#112">112</a>         } <strong class="jxr_keyword">else</strong> {
<a name="113" href="#113">113</a>             <strong class="jxr_keyword">return</strong> instant - instant % iUnitMillis;
<a name="114" href="#114">114</a>         }
<a name="115" href="#115">115</a>     }
<a name="116" href="#116">116</a> 
<a name="117" href="#117">117</a>     <em class="jxr_javadoccomment">/**</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * This method assumes that this field is properly rounded on</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * 1970-01-01T00:00:00. If the rounding alignment differs, override this</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * method as follows:</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * return super.remainder(instant + ALIGNMENT_MILLIS);</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     */</em>
<a name="125" href="#125">125</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> remainder(<strong class="jxr_keyword">long</strong> instant) {
<a name="126" href="#126">126</a>         <strong class="jxr_keyword">if</strong> (instant &gt;= 0) {
<a name="127" href="#127">127</a>             <strong class="jxr_keyword">return</strong> instant % iUnitMillis;
<a name="128" href="#128">128</a>         } <strong class="jxr_keyword">else</strong> {
<a name="129" href="#129">129</a>             <strong class="jxr_keyword">return</strong> (instant + 1) % iUnitMillis + iUnitMillis - 1;
<a name="130" href="#130">130</a>         }
<a name="131" href="#131">131</a>     }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>     <em class="jxr_javadoccomment">/**</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * Returns the duration per unit value of this field. For example, if this</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * field represents "minute of hour", then the duration field is minutes.</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     *</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     * @return the duration of this field, or UnsupportedDurationField if field</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">     * has no duration</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     */</em>
<a name="140" href="#140">140</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DurationField.html">DurationField</a> getDurationField() {
<a name="141" href="#141">141</a>         <strong class="jxr_keyword">return</strong> iUnitField;
<a name="142" href="#142">142</a>     }
<a name="143" href="#143">143</a> 
<a name="144" href="#144">144</a>     <em class="jxr_javadoccomment">/**</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * Get the minimum value for the field.</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * </em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     * @return the minimum value</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     */</em>
<a name="149" href="#149">149</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMinimumValue() {
<a name="150" href="#150">150</a>         <strong class="jxr_keyword">return</strong> 0;
<a name="151" href="#151">151</a>     }
<a name="152" href="#152">152</a> 
<a name="153" href="#153">153</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> getUnitMillis() {
<a name="154" href="#154">154</a>         <strong class="jxr_keyword">return</strong> iUnitMillis;
<a name="155" href="#155">155</a>     }
<a name="156" href="#156">156</a> 
<a name="157" href="#157">157</a>     <em class="jxr_javadoccomment">/**</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * Called by the set method to get the maximum allowed value. By default,</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * returns getMaximumValue(instant). Override to provide a faster</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * implementation.</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     */</em>
<a name="162" href="#162">162</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getMaximumValueForSet(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">int</strong> value) {
<a name="163" href="#163">163</a>         <strong class="jxr_keyword">return</strong> getMaximumValue(instant);
<a name="164" href="#164">164</a>     }
<a name="165" href="#165">165</a> 
<a name="166" href="#166">166</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

